home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / mailers / mtraf10.zip / MTRAFFIC.DOC < prev    next >
Text File  |  1992-10-29  |  13KB  |  310 lines
  1.  
  2.     Version 1.00, October 30, 1992
  3.                  DO NOT DISTRIBUTE
  4.  
  5.        M   M  TTTTT  RRRR     A    FFFFF  FFFFF  II   CCC
  6.        MM MM    T    R   R   A A   F      F      II  C   C
  7.        M M M    T    RRRR   A   A  FFF    FFF    II  C
  8.        M   M    T    R   R  AAAAA  F      F      II  C   C
  9.        M   M    T    R   R  A   A  F      F      II   CCC
  10.  
  11.  
  12.       RICH VERAA'S LITTLE *.MSG MESSAGEBASE TRAFFIC REPORT
  13.  
  14.                          A BIRDSOFT PROGRAM
  15.  
  16.    (C) Copyright 1991, 1992 by Richard P. Veraa. All rights reserved.
  17.        Veraa-Birdsoft Computer Products. North Miami, Florida, USA
  18.  
  19.         MTRAFFIC.EXE is a simple messagebase traffic volume report
  20.    generator for use with bulletin board systems using the popular
  21.    *.MSG (Opus-type) messagebase. MTRAFFIC generates an individual
  22.    report for each conference area listed in AREAS.BBS, (or a restricted
  23.    list that you prepare) and tabulates each poster to that echo during
  24.    the report period in order of activity, with the number of messages
  25.    posted, the average size of messages by that author, and his/her net
  26.    origin number of origin, as well as a total number of messages and
  27.    posters for each area. You may compile reports of all traffic in an
  28.    area, or of messages entered from your board only.
  29.  
  30.    MTRAFFIC.EXE also generates a summary report listing number of
  31.    messages in all areas.
  32.  
  33.    FILES IN THIS ARCHIVE
  34.  
  35.    README.RPT - Last minute details.
  36.    MTRAFFIC.DOC - This document.
  37.    AREANAME.RPT - Sample area report produced by MTRAFFIC.
  38.    SUMMARY.RPT  - Sample summary report produced by MTRAFFIC.
  39.    MTRAFFIC.EXE - MTRAFFIC executable file.
  40.    MTSETUP.EXE  - MTRAFFIC Configuration program.
  41.    SETPLACE.EXE - Utility to reset the MTRAFFIC lastread pointers.
  42.    REGISTER.RPT - Registration information.
  43.  
  44.  
  45.    GUARANTEE
  46.  
  47.    There is no guarantee, express or implied. This program works well on
  48.    my system and the systems on which it's been tested... Your mileage,
  49.    as the saying goes, may vary.
  50.  
  51.    USER DEVELOPED SOFTWARE
  52.  
  53.    This program is Shareware. It is NOT free, and it is NOT public
  54.    domain. You may try it out for the period of one month. If you decide
  55.    to continue to use it after that month, you should register your
  56.    copy. I'm not a professional programmer, I just program for fun. All
  57.    of what you see is done in my spare time, and the bills are paid out
  58.    of my own pocket. MTRAFFIC will not stop working after one month, or
  59.    do anything nasty, nor does the registered version have more features
  60.    than the non-registered version. (except for nicely identifying you
  61.    on the reports it generates). However, if you don't register
  62.    MTRAFFIC, I will not be able to continue to work on it and implement
  63.    new user requested features. So support shareware!
  64.  
  65.    REGISTRATION
  66.  
  67.    For information on how to register, see the file REGISTER.RPT that's in
  68.    the MTRAFFIC distribution file. When I've received your registration
  69.    form and registration fee, i will send you a registration key via
  70.    netmail or snailmail (post). MTRAFFIC will list your name and BBS
  71.    name on the reports it generates to indicate that you're using a
  72.    registered version of MTRAFFIC.
  73.  
  74.  
  75.  
  76.    INTRODUCTION
  77.  
  78.    MTRAFFIC.EXE works by reading the area tag names from the AREAS.BBS
  79.    file. (or a limited selection of these in a file called AREAS.RPT
  80.    that you create). It then searches the messagebase for messages in
  81.    that area, and looks up each poster's net address in the origin lines
  82.    of his/her messages.
  83.  
  84.    INSTRUCTIONS
  85.  
  86.       Installation
  87.  
  88.    1. *.MSG (Opus/Fido) Messagebase
  89.  
  90.    You must be using a BBS program like Opus, Maximus, or PCBoard
  91.    that utilizes a *.MSG messagebase .... that is, you must have
  92.    directories for each area containing each message as a FTS-0001
  93.    standard *.MSG file, and you must have an AREAS.BBS control file.
  94.  
  95.    2. AREAS.BBS
  96.  
  97.    You also need a file called AREAS.BBS listing the message areas on
  98.    your BBS. If your setup does not use AREAS.BBS, see Appendix A of
  99.    this document for instructions on constructing one.
  100.  
  101.    If you do not want MTRAFFIC to report on ALL the message areas on
  102.    your system, you may prepare a file called AREAS.RPT. MTRAFFIC looks
  103.    for AREAS.RPT first; if it isn't there, it reads AREAS.BBS. The
  104.    easiest way to construct AREAS.RPT is to simply copy AREAS.BBS to
  105.    AREAS.RPT and then use an editor to delete the lines for the areas
  106.    you do NOT want reports on. Note that MTRAFFIC will start reading at
  107.    the THIRD line of this file.
  108.  
  109.    3. MTRAFFIC.EXE, SETPLACE.EXE and MTSETUP.EXE
  110.    Place the above executable files in the same directory as whatever
  111.    messagebase management utilities you run nightly. This may be the
  112.    same directory as your mailer or your BBS, depending on how your
  113.    system is set up. If (as I sincerely hope) you are registered,
  114.    place your key, MTRAFFIC.KEY in this directory as well.
  115.  
  116.    4. Configure MTRAFFIC by running MTSETUP.
  117.  
  118.    Run MTSETUP from the command line and simply fill in the blanks on
  119.    the screen. You may use the up and down arrows to change fields until
  120.    all blanks are correct. Then press <F-10> to accept the displayed
  121.    information.
  122.  
  123.       Enter your name as it appears on your registration form
  124.  
  125.       Enter your BBS or point name -- or your own name. This is the name
  126.       that will appear on the reports MTRAFFIC generates. (if you are a
  127.       registered user).
  128.  
  129.       Enter your net node or point address (enclosed in parentheses).
  130.  
  131.       Enter the date of the beginning of your first report. This
  132.       defaults to today's date, but you may want to reset it from time
  133.       to time.  When you run MTRAFFIC with the "/n" switch (new data
  134.       period), this date will reset to the current date at the end of
  135.       your run, remove current data, and reset the data files. It's
  136.       recommended that you use this option weekly, or at regular
  137.       intervals, creating reports (with the "/r" switch) that cover
  138.       traffic through your system during a uniform period.
  139.  
  140.  
  141.       Enter the full path designations for the files MTRAFFIC needs to
  142.       find:
  143.  
  144.       AREAS.BBS                           The arealist.
  145.            or
  146.       AREAS.RPT                           abbreviated arealist.
  147.  
  148.       MTRAFFIC will ordinarily prepare reports for all areas listed in
  149.       AREAS.BBS. If you do not want to count all the areas listed, you
  150.       may make an abbreviated file of just the areas you wish to look at
  151.       -- just make a copy of AREAS.BBS named AREAS.RPT.  Delete the
  152.       lines from AREAS.RPT that you do not with reported on.  If
  153.       MTRAFFIC finds AREAS.RPT in the directory listed in the
  154.       configuration file, it will read it, otherwise, it will look at
  155.       AREAS.BBS.
  156.  
  157.       Enter the path designations for the directories where you wish
  158.       MTRAFFIC to place its reports and data files. The defaults place
  159.       the individual area reports and summary reports in a subdirectory
  160.       of the mailer, but you may have them placed in any valid directory
  161.       on your system.
  162.  
  163.       If MTSETUP can not find a directory you specify (or does not find
  164.       the files it needs), it will warn you via a notice on the screen.
  165.       CAUTION -- it will, however, accept the data you key in. It's your
  166.       responsibility to create the appropriate directories and assure
  167.       the proper files are available in them.
  168.  
  169.  
  170.    5. Operation
  171.  
  172.    Running MTRAFFIC.EXE.
  173.  
  174.    Every time MTRAFFIC is run, it retrieves its own data and scans the
  175.    message base for new messages in all areas.
  176.  
  177.    MTRAFFIC will also generate a summary file called SUMMARY.RPT, listing
  178.    all the areas listed in AREAS.BBS, with the total number of messages
  179.    posted in each.
  180.  
  181.    6. Command line switches
  182.  
  183.    MTRAFFIC may be followed by any combination of three command line
  184.    switches (plus "/h" for a help screen):
  185.  
  186.      /r   REPORT on individual areas
  187.  
  188.    MTRAFFIC will generate a separate text file for each area, named
  189.    <tagname>.RPT (tagname truncated at eight characters), listing the
  190.    posters to that area in order of the number of messages posted, along
  191.    with the number of messages posted, and the writer's net address, if
  192.    MTRAFFIC can find it on an origin line in the poster's message.
  193.  
  194.      /n   NEW data.
  195.  
  196.    Ordinarily MTRAFFIC continues to accumulate data so that (assuming
  197.    it's run daily) each days' reports show the current day's mail added
  198.    to the previous day's report. When the /n switch is used, MTRAFFIC
  199.    will write it's reports and then discard its old data to start a
  200.    fresh reporting period. It will also reset its beginning date for
  201.    future report periods. I run the /n option every two weeks.
  202.  
  203.       /t  No Transit mode
  204.  
  205.    The /t switch tells MTRAFFIC to ignore messages with the InTransit
  206.    bit set. Use this if your mail processing software sets this bit to
  207.    indicate old messages such as in the case of using InterPCB to convert
  208.    your *.msg into PCBoard's MSGS file.
  209.  
  210.  
  211.    6. SETPLACE.EXE
  212.  
  213.    Every time MTRAFFIC runs, it creates a two-byte file called
  214.    MTRAFF.NUM, in each message area directory, which keeps track of the
  215.    last message number accounted for. However, if your messagebase
  216.    cleanup utilities renumber the messagebase, this number will change.
  217.    Accordingly, the little utility SETPLACE.EXE is used to reset
  218.    MTRAFF.NUM to the same number the last message is changed to. To make
  219.    sure no messages go unreported, it's a good idea to run MTRAFFIC
  220.    immediately before cleanup and SETPLACE immediately after, as
  221.    described in the next section.
  222.  
  223.    7. Running MTRAFFIC from a batch file.
  224.  
  225.    The best way to run MTRAFFIC is to call it every night from the batch
  226.    file that runs during your cleanup event. Call MTRAFFIC just before
  227.    cleanup and SETPLACE just after, so that your batch file should look
  228.    something like the following:
  229.  
  230.    CLEAN.BAT
  231.  
  232.               MTRAFFIC /r
  233.               mbutil purge
  234.               mbutil pack
  235.               mbutil link
  236.               SETPLACE
  237.  
  238.    You'll note that I use the /r (report) option every night.. that way
  239.    I've always got a current report of each echo area in a directory I
  240.    call \FD\STAT\. Every two weeks, I run MTRAFFIC /n /r from the
  241.    command line to make final "official" reports for that period, that
  242.    I can archive for my records.
  243.  
  244.    8. That's all there is to it!
  245.  
  246.    You may register this program for US$ 10.00 and I will send you a key
  247.    that will work on subsequent regular versions.
  248.  
  249.  
  250.    Contact me for further information, help, bug reports, comments, or
  251.    Christmas greetings at:
  252.  
  253.            FidoNet 1:135/907
  254.            Internet rveraa@newssun.med.miami.edu
  255.  
  256.            or by SnailMail at:
  257.  
  258.            Richard Veraa
  259.            Room 211
  260.            Villa Maria Nursing Center
  261.            1050 N.E. 125 Street
  262.            North Miami, FL 33161
  263.  
  264.     Thanks to .\\ichele Stewart for alpha testing this program, and for
  265.     not giving up on it through the search for some puzzling insects.
  266.  
  267.                    Thanks a lot,
  268.  
  269.                    Cheers,
  270.                      Rich Veraa
  271.  
  272.    RELATED PROGRAMS:
  273.  
  274.       HTRAFFIC.EXE -- a program similar to MTRAFFIC designed for use
  275.       with the popular Hudson messagebase used with RA, QuickBBS and
  276.       other boards. Archived as HTRAFnnn.ARJ.
  277.  
  278.  
  279.    APPENDIX A.
  280.                        AREAS.BBS
  281.  
  282.    AREAS.BBS is a plain ASCII text file listing the message areas of
  283.    your BBS in the following format:
  284.  
  285.    Line 1: Your BBS Name
  286.  
  287.    Line 2: A semicolon (;)
  288.  
  289.    Remaining lines: The area number and tag name of each message area
  290.    you carry in the following format. Note that the example below lists
  291.    net addresses for uplinks, which some software requires. MTRAFFIC,
  292.    however, does not use these numbers and they are unnecessary for its
  293.    operation. In any case though, a column at least 31 characters wide
  294.    must be available for the path and 20 for the tag name.
  295.  
  296.    If you do not wish to generate traffic reports for all the echos
  297.    carried by your system, make a file in the same form as AREAS.BBS,
  298.    but call it AREAS.RPT, and list only the message areas you wish
  299.    MTRAFFIC to scan, as described in the installation instructions.
  300.  
  301.  
  302. Birdsoft Online! Rich Veraa
  303. ;
  304. D:\FD\MSG\PASCAL\              PASCAL               135/142
  305. D:\FD\MSG\EREQ\                ECHO_REQ             135/142
  306. D:\FD\MSG\NETSYSOP\            NETSYSOP             135/142
  307. D:\FD\MSG\POST\                SYSOP_JUNGLE         135/142
  308. D:\FD\MSG\MEDIEVAL\            MEDIEVAL             129:131/46
  309.  
  310.